home *** CD-ROM | disk | FTP | other *** search
/ Best of Shareware / Best of PC Windows Shareware 1.0 - Wayzata Technology (7111) (1993).iso / mac / DOS / UTILITY / ZILITE / ZI-LITE.TXT < prev   
Text File  |  1992-08-05  |  19KB  |  661 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.                                  Z/Install Lite
  32.                     (c) Copyright 1992 SpeedSOFT Development
  33.                                All rights reserved
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                                                         Page 1
  65.  
  66.  
  67.  
  68.  
  69.    TABLE OF CONTENTS                                                      PAGE
  70.  
  71.    Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . . .  Page 3
  72.         What is Z/Install Lite?  . . . . . . . . . . . . . . . . . . .  Page 3
  73.         What ZI/Lite WON'T do  . . . . . . . . . . . . . . . . . . . .  Page 3
  74.         Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . .  Page 3
  75.         Creating a ZI/Lite configuration file  . . . . . . . . . . . .  Page 4
  76.         Editing a ZI/Lite configuration file . . . . . . . . . . . . .  Page 4
  77.              Program Name  . . . . . . . . . . . . . . . . . . . . . .  Page 4
  78.              Author's Name . . . . . . . . . . . . . . . . . . . . . .  Page 4
  79.              Exit Message  . . . . . . . . . . . . . . . . . . . . . .  Page 5
  80.              'Done Install' message  . . . . . . . . . . . . . . . . .  Page 5
  81.              Default drive/dir to install to . . . . . . . . . . . . .  Page 5
  82.              Immediate abort on CRC fail . . . . . . . . . . . . . . .  Page 5
  83.              Automatically overwrite existing  . . . . . . . . . . . .  Page 5
  84.              Space required to install . . . . . . . . . . . . . . . .  Page 5
  85.              Title screen binary file name . . . . . . . . . . . . . .  Page 5
  86.         Details  . . . . . . . . . . . . . . . . . . . . . . . . . . .  Page 6
  87.  
  88.    Using the ZPack Lite compression utility  . . . . . . . . . . . . .  Page 7
  89.         Command line switches for ZPACK.EXE  . . . . . . . . . . . . .  Page 7
  90.         Add files (create archive) . . . . . . . . . . . . . . . . . .  Page 7
  91.         Delete files . . . . . . . . . . . . . . . . . . . . . . . . .  Page 7
  92.         Freshen files  . . . . . . . . . . . . . . . . . . . . . . . .  Page 7
  93.         List files . . . . . . . . . . . . . . . . . . . . . . . . . .  Page 7
  94.         Extract pack . . . . . . . . . . . . . . . . . . . . . . . . .  Page 7
  95.         Overwrite without prompting  . . . . . . . . . . . . . . . . .  Page 8
  96.         Assign work drive  . . . . . . . . . . . . . . . . . . . . . .  Page 8
  97.         Exclude 'file' . . . . . . . . . . . . . . . . . . . . . . . .  Page 8
  98.         Skip time/date stamp check . . . . . . . . . . . . . . . . . .  Page 8
  99.  
  100.    Creating the final installation program . . . . . . . . . . . . . .  Page 9
  101.         Run ZI-Bind  . . . . . . . . . . . . . . . . . . . . . . . . .  Page 9
  102.  
  103.    Appendix A  . . . . . . . . . . . . . . . . . . . . . . . . . . . . Page 10
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                                                                         Page 2
  131.  
  132.  
  133.  
  134.                                     Chapter 1
  135.                                   Introduction
  136.  
  137.  
  138.    What is Z/Install Lite?
  139.    ---------------------------------------------------------------------------
  140.  
  141.    Z/Install Lite is a great choice for  Shareware authors.  Most of us  don't
  142.    need to modify CONFIG.SYS and AUTOEXEC.BAT or have other  fancy features in
  143.    our installation programs.  We can hardly use batch files, though!  This is
  144.    where ZI/Lite  comes in.  It provides the end  user with a snazzy, windowed
  145.    interface from which  to install  the program.   The user requirements  are
  146.    almost  non-existent!  All  he/she has  to do is  supply a path  (which the
  147.    developer can provide a default for) and that's it!
  148.  
  149.    ZI/Lite  may  be  small on  size,  but  it isn't  lacking  in  the features
  150.    department.   Through  this  document,  we'll take  you  on the  three-step
  151.    process that it  takes to create your own ZI/Lite installation.  We'll show
  152.    you  how to define the first  screen that the user  sees, how much space is
  153.    needed  to  install, and  more!   You'll  quickly  see that  ZI/Lite  is an
  154.    indispensable tool for any Shareware author.
  155.  
  156.    IMPORTANT NOTE:     Please  read  the  file  LICENSE.DOC  for info  on  the
  157.                        'limited shareware license' that comes with  the freely
  158.                        distributable version of ZI/Lite  (the version you have
  159.                        right now).
  160.  
  161.  
  162.    What ZI/Lite WON'T do
  163.    ---------------------------------------------------------------------------
  164.  
  165.    The main feature of ZI/Lite is its  tiny size.  Therefore, it does not have
  166.    any advanced features,  such as file grouping and  customizable user input.
  167.    If these are  the kind of features  you are looking for,  contact SpeedSOFT
  168.    Development  (see  Appendix  A) for  information  about  Z/Install Standard
  169.    Edition.  It uses a powerful script language much like BASIC to control the
  170.    installation.  See  the file ZINSTALL.STD, included with  this archive, for
  171.    information.
  172.  
  173.    Best of all, if you buy Z/Install Standard Edition, you get  Z/Install Lite
  174.    absolutely free of charge!  
  175.  
  176.  
  177.    Concepts 
  178.    ---------------------------------------------------------------------------
  179.  
  180.    First, the developer uses ZI/Lite's  powerful archiving program to create a
  181.    compressed  'pack' of  files (see chapter  2 for  information).   This pack
  182.    contains all the files that make up the developer's application.  
  183.  
  184.    The next  step is  to create  a configuration  file for  ZI/Lite using  the
  185.    MakeInst  utility.   This  is described  in detail  later in  this chapter.
  186.    After  specifying  the  ZI/Lite  parameters  with  MakeInst,  it  creates a
  187.    'virgin'  data  file  with  the  extension  '.ZID'.    This  file  is   the
  188.    installation program.
  189.  
  190.    NOTE:     The virgin  data file  can be compressed  with utilities  such as
  191.              LZEXE  and DIET.   In fact, we recommend  it because it decreases
  192.              the overall size of your distribution archive.
  193.  
  194.    The last  step is to run  the ZI/Lite binding utility.   This program binds
  195.  
  196.                                                                         Page 3
  197.  
  198.  
  199.  
  200.    the virgin data file and the archived pack into one EXE file which can then
  201.    be distributed (see chapter 3).
  202.  
  203.  
  204.    Creating a ZI/Lite configuration file
  205.    ---------------------------------------------------------------------------
  206.    From the ZI/Lite directory, run 'MAKEINST.EXE'.  This program will create a
  207.    configuration file with  the extension '.ZIL' for ZI/Lite.   MakeInst takes
  208.    two command line  parameters.  The first  is the name of  the configuration
  209.    file to  create/update, and  the second  is the  name of  the data  file to
  210.    create.
  211.  
  212.    For example, the command:
  213.  
  214.         MAKEINST ZI-LITE INSTALL
  215.  
  216.    would  create  a  configuration  file  called  'ZI-LITE.ZIL'  and  a virgin
  217.    installation data file called 'INSTALL.ZID'.
  218.  
  219.    If the configuration file specified is not on the disk, it will be created.
  220.    Otherwise, MakeInst will ask you if you want to change the configuration in
  221.    the specified file before writing the installation data file.
  222.  
  223.    You can provide a default for  the "Modify configuration [Y/N]" prompt with
  224.    the optional  parameter "/Y or /N".  This  parameter must come before every
  225.    other parameter on the command line.
  226.  
  227.  
  228.    Editing a ZI/Lite configuration file
  229.    ---------------------------------------------------------------------------
  230.  
  231.    When a new configuration  file is created,  you are automatically taken  to
  232.    the configuration  editing dialog.   This dialog lets the  developer choose
  233.    the default directory, the opening screen, and more.  Each editing field is
  234.    described in detail below.
  235.  
  236.      Program Name
  237.      ------------------------------------------------------------------------
  238.  
  239.      This is the  name of the program that  ZI/Lite will install.  It is shown
  240.      to the user numerous times during the installation.
  241.  
  242.  
  243.      Author's Name
  244.      ------------------------------------------------------------------------
  245.  
  246.      This is the name  of the author of the program.  It could be your company
  247.      name, or just yours.  It should  include a phone number to  reach you at,
  248.      because this  message is shown if  an error occurs, such  as a CRC  fail.
  249.      The user would see:
  250.  
  251.      WARNING: One or more files are DAMAGED.  Please contact the authors at:
  252.      * Author's name here *
  253.  
  254.      The  above  message  will  also  appear  in   a  red  window  after   the
  255.      installation is complete if an error occurred.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                                                                         Page 4
  263.  
  264.  
  265.  
  266.      Exit Message
  267.      ------------------------------------------------------------------------
  268.  
  269.      This  is  displayed to  the  user  when the  program  returns to  the DOS
  270.      prompt.   Since ZI/Lite restores the  original DOS screen  upon exit, the
  271.      user would see:
  272.  
  273.      C:\>INSTALL
  274.      * Exit message here *
  275.  
  276.      C:\>
  277.  
  278.  
  279.      'Done Install' message
  280.      ------------------------------------------------------------------------
  281.  
  282.      This  is displayed to  the user upon completion of  the installation.  It
  283.      appears in a centred window after all the files have been decompressed.
  284.  
  285.  
  286.      Default drive/dir to install to 
  287.      ------------------------------------------------------------------------
  288.  
  289.      This is  the default drive  and directory that  the installation  program
  290.      will use.  The user can edit it before the installation starts.  
  291.  
  292.  
  293.      Immediate abort on CRC fail
  294.      ------------------------------------------------------------------------
  295.  
  296.      Set  this option to 'Y' if  you want the installation program to abort as
  297.      soon as it encounters  a CRC error  in the archive.  The user  will see a
  298.      red window with the message described in the "Author's Name" field.
  299.  
  300.  
  301.      Automatically overwrite existing
  302.      ------------------------------------------------------------------------
  303.  
  304.      If this  is set to 'N', the  installation program will prompt the user to
  305.      overwrite any existing files.
  306.  
  307.  
  308.      Space required to install
  309.      ------------------------------------------------------------------------
  310.  
  311.      This is the minimum amount  of space required to  install the program (in
  312.      bytes).
  313.  
  314.  
  315.      Title screen binary file name
  316.      ------------------------------------------------------------------------
  317.  
  318.      In  order to  conserve  disk space  and code  length in  the installation
  319.      program,  ZI/Lite simply copies a  4000-byte buffer to  the screen.  This
  320.      buffer is comprised of 2000 characters and  2000 attribute bytes, in  the
  321.      format  "character attribute character  attribute", etc.  These files can
  322.      be  created  with the  popular  screen  designer TheDraw,  or  any  other
  323.      program that saves binary screen shots.
  324.  
  325.      The file specified  here is read  into a buffer and copied  into the data
  326.      segment of the virgin installation file.
  327.  
  328.                                                                         Page 5
  329.  
  330.  
  331.  
  332.  
  333.    After all fields have been completed, press <ESC> to save the configuration
  334.    file and exit  the program.  Upon  completion, MakeInst will write  out the
  335.    data file specified on the command line.
  336.  
  337.  
  338.    Details
  339.    ---------------------------------------------------------------------------
  340.  
  341.    The following details should be noted:
  342.  
  343.      -  Multiple subdirectories in the default directory are acceptable.   For
  344.         example, C:\APPS\UTILS\ZI-LITE is ok.
  345.  
  346.      -  ZI/Lite exits to the destination drive/directory.
  347.  
  348.      -  The installation can be aborted at any time with the <ESC> key.
  349.  
  350.      -  ZI/Lite works with DOS 2.0+
  351.  
  352.      -  ZI/Lite requires only 68k of conventional memory.
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.                                                                         Page 6
  395.  
  396.  
  397.  
  398.                                     Chapter 2
  399.                     Using the ZPack Lite compression utility
  400.  
  401.    Command line switches for ZPACK.EXE
  402.    ---------------------------------------------------------------------------
  403.  
  404.    ZPack has a relatively simple command line syntax.  It is as follows:
  405.  
  406.         ZPACK <action> [/options] <filename[.ZPK]> [filenames...]
  407.  
  408.         The parsing syntax for the command line is:
  409.  
  410.         []  - Anything  enclosed in  these  is optional  in most  cases.   For
  411.         example,  the [filenames...]  parameter is  not required  to  view the
  412.         contents of an  archive, but is  definitely required to add  or delete
  413.         files from the archive.
  414.  
  415.         <> -  Parameters enclosed in  these are  mandatory and cannot  be left
  416.         out.  Doing so will cause ZPack to report an error.
  417.  
  418.         ...- Means one or more of the same type of parameter may be used. This
  419.         means you  can have  multiple filenames/wildcards  in the  [filenames]
  420.         parameter, separated with spaces.
  421.  
  422.    Note:     When specifying the archive name,  it is not necessary to put  in
  423.              the extension (.ZPK).   If you  DO put an in  extension, however,
  424.              ZPack will look for the specified file instead of appending .ZPK.
  425.  
  426.    The parameter <action> is  the function that you want ZPack  to perform. It
  427.    can be one of the following:
  428.  
  429.         A - Add  files (create  archive).   If the archive  file specified  is
  430.         missing,  it  will   be  created.    Wildcards  are   allowed  in  the
  431.         [filenames...] parameter. 
  432.  
  433.                   Sample:  zpack a program *.exe *.dat
  434.  
  435.         D -  Delete files.   The  files  specified in  [filenames...] will  be
  436.         deleted from  the archive.   Wildcards are allowed. ZPack  will prompt
  437.         you  to Save the Changes (Y/N) after it deletes the files, so you have
  438.         a chance to make a mistake.
  439.  
  440.                   Sample:  zpack d program *.exe *.dat
  441.  
  442.         F  -  Freshen  files.   This  is  a  powerful  command.    ZPack  will
  443.         sequentially read the  file records in the archive and  match the date
  444.         and time of  each one to  the date and time  of the same files  on the
  445.         disk drive.  If the file on  the drive is  newer than the file  in the
  446.         archive,  the archived file  will be updated  with the new  data.  The
  447.         [filenames...] parameter is ignored with this action.
  448.  
  449.                   Sample:  zpack f program
  450.  
  451.         L  - List  files.   This  will  give a  summary  of the  files in  the
  452.         specified  archive.    Wildcards  are  allowed on  the  [filenames...]
  453.         parameter.
  454.  
  455.                   Sample:  zpack l program *.exe
  456.  
  457.         X - Extract pack.  This will  extract the files from the archive  into
  458.         the current drive/directory.   If the file already exists, you will be
  459.  
  460.                                                                         Page 7
  461.  
  462.  
  463.  
  464.         prompted  to  overwrite  it or  not.    Wildcards are  allowed  on the
  465.         [filenames...] parameter.
  466.  
  467.                   Sample:  zpack x program *.dat
  468.  
  469.    The optional parameter [/options] can be one or more of the following:
  470.  
  471.         O - Overwrite  without prompting.   This  option will  force ZPack  to
  472.         overwrite  any  existing files  without  prompting when  extracting an
  473.         archive.  Note: Use this with caution, as it may result  in accidental
  474.         loss of data!
  475.  
  476.                   Sample:  zpack x /o program
  477.  
  478.         W<disk>- Assign  work drive.   This applies to all  actions. Normally,
  479.         <disk> would  be a RAM disk.   ZPack uses temporary files  and a great
  480.         deal of  disk activity can result when  performing archive operations.
  481.         Set this to the fastest disk on your system.
  482.  
  483.                   Sample:  zpack a /wd program 
  484.  
  485.         E<file>-  Exclude 'file'.   This  option  excludes all  files matching
  486.         'file' from  the selected  operation.  Wildcards  (?, *)  are allowed.
  487.         This must  be the  last OPTION  on the  command line.   The  following
  488.         example would  add all files  in the current directory  to "DOCS.ZPK",
  489.         excluding files matching "*.BAK":
  490.  
  491.                   zpack a /e*.bak docs *.*
  492.  
  493.         T - Skip  time/date stamp check.   This option, which applies  only to
  494.         the  freshen command, ignores  the time and  date of the  files in the
  495.         archive and freshens every file.
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.                                                                         Page 8
  527.  
  528.  
  529.  
  530.                                     Chapter 3
  531.                      Creating the final installation program
  532.  
  533.    Run ZI-Bind
  534.    ---------------------------------------------------------------------------
  535.  
  536.    The ZI-Bind  utility will bind a virgin installation  data file and a ZPack
  537.    archive  into one EXE file.   The resulting EXE can  then be distributed to
  538.    customers.
  539.  
  540.    ZI-Bind has a simple command-line interface.  It is as follows:
  541.  
  542.         ZI-BIND <virginfile[.ZID]> <archivefile[.ZPK]> [outfile[.EXE]]
  543.  
  544.         Virginfile  is the  name of the  data file  that the  MakeInst utility
  545.         created.
  546.  
  547.         Archivefile  is the  name  of  a ZPack  archive  file.   This  archive
  548.         contains all the files that make up your application.
  549.  
  550.         Outfile is an optional parameter that is used to specify an  alternate
  551.         EXE  filename for  the installation  program.   If  this parameter  is
  552.         omitted, virginfile.EXE will be created.
  553.  
  554.  
  555.    Once you have  run ZI-Bind, you  have a complete  installation program  for
  556.    your users.  Wasn't that easy?
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.                                                                         Page 9
  593.  
  594.  
  595.  
  596.                                    Appendix A
  597.  
  598.    How to reach SpeedSOFT Development
  599.    ---------------------------------------------------------------------------
  600.  
  601.    You  can  call us  at: (604)  472-0626,  9 a.m.  to 9  p.m.  Monday through
  602.    Saturday
  603.  
  604.    Our  BBS is up 7 days a week.  The phone number is (604) 477-5337.  The BBS
  605.    supports 16.8k HST and v.32(bis) protocols, as well as 300-2400 baud.
  606.  
  607.    And, finally, you can write to us at:
  608.  
  609.         SpeedSOFT Development
  610.         2232 Tashy Place
  611.         Victoria, BC, Canada
  612.         V8N 4R6
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.  
  625.  
  626.  
  627.  
  628.  
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.                                                                        Page 10
  659.  
  660.  
  661.